+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/gtklabel.c: Fix docs. (#66383)
+
+ * gtk/gtkbbox.c (gtk_button_box_set_child_secondary): Fix docs.
+ (#66278, #66280)
+
+ * gdk/gdkwindow.h (gdk_window_get_deskrelative_origin),
+ gdk/gdkimage.h (gdk_image_get): Deprecate. (#66208)
+
+ * gtk/gtkcolorsel.c (gtk_color_selection_set_update_policy):
+ Don't emit a g_warning() about being deprecated. (#66208)
+
+ * gtk/gtkaccellabel.c (gtk_accel_label_set_accel_widget): Add docs.
+
+ * gtk/gtkcontainer.c: Doc fixes.
+
+ * gtk/gtkliststore.c (gtk_list_store_clear): Add docs; misc doc fixes.
+
+ * gtk/gtkstyle.c (gtk_style_attach): Add docs.
+
2001-12-05 Sven Neumann <sven@gimp.org>
* gtk/gtkwidget.c (gtk_widget_reset_shapes): close comment.
+2001-12-06 Matthias Clasen <matthiasc@poet.de>
+
+ * gtk/tmpl/gtklabel.sgml: Remove redundant docs. (#66383)
+
+ * gtk/tree_widget.sgml: Typo fix. (#66256)
+
+ * gdk-pixbuf/Makefile.am (SCAN_OPTIONS): Add --deprecated-guards.
+
+ * gtk/tmpl/gtktext.sgml, gtk/tmpl/gtktree.sgml,
+ gtk/tmpl/gtktreeitem.sgml: Updates.
+
2001-12-04 Matthias Clasen <matthiasc@poet.de>
* gtk/tmpl/gtkwidget.sgml: Updates.
DOC_SOURCE_DIR=../../../gdk-pixbuf
# Extra options to supply to gtkdoc-scan
-SCAN_OPTIONS=--source-dir=../../../contrib/gdk-pixbuf-xlib
+SCAN_OPTIONS=--source-dir=../../../contrib/gdk-pixbuf-xlib --deprecated-guards="GDK_PIXBUF_ENABLE_BROKEN|GDK_PIXBUF_DISABLE_DEPRECATED"
# Extra options to supply to gtkdoc-mkdb
MKDB_OPTIONS=--sgml-mode --source-dir=../../../contrib/gdk-pixbuf-xlib
A widget that displays a small to medium amount of text.
<!-- ##### SECTION Long_Description ##### -->
-<para>\r
-The #GtkLabel widget is usually used directly by the programmer to display\r
-word(s) describing an adjacent widget or its use. It is also used internally\r
-by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which\r
-use text.\r
+<para>
+The #GtkLabel widget is usually used directly by the programmer to display
+word(s) describing an adjacent widget or its use. It is also used internally
+by Gtk+ as #GtkButton labels, #GtkMenu items, and many other widgets which
+use text.
</para>
<!-- ##### SECTION See_Also ##### -->
-<para>\r
-\r
+<para>
+
</para>
<!-- ##### STRUCT GtkLabel ##### -->
-<para>\r
-This should not be accessed directly. Use the accessor functions as\r
-described below.\r
+<para>
+This should not be accessed directly. Use the accessor functions as
+described below.
</para>
<!-- ##### FUNCTION gtk_label_new ##### -->
-<para>\r
-Creates a new label with the given string of text inside it. You can\r
-pass NULL to get an empty label widget.\r
+<para>
+
</para>
-@str: The string you want to display in the #GtkLabel
-@Returns: The newly allocated #GtkLabel widget
+@str:
+@Returns:
<!-- ##### FUNCTION gtk_label_set_text ##### -->
-<para>\r
-Sets the text within the #GtkLabel widget. It overwrites any text that\r
-was there before. Note that underlines that were there before do not\r
-get overwritten. If you want to erase underlines just send NULL to\r
-gtk_label_set_pattern().\r
+<para>
+
</para>
-@label: The #GtkLabel you want to set the text for.
-@str: The text you want to add.
+@label:
+@str:
<!-- ##### FUNCTION gtk_label_set_attributes ##### -->
<!-- ##### FUNCTION gtk_label_set_pattern ##### -->
-<para>\r
-The pattern of underlines you want under the existing text within the\r
-#GtkLabel widget. For example if the current text of the label says\r
-"FooBarBaz" passing a pattern of "___ ___" will underline\r
-"Foo" and "Baz" but not "Bar".\r
+<para>
+The pattern of underlines you want under the existing text within the
+#GtkLabel widget. For example if the current text of the label says
+"FooBarBaz" passing a pattern of "___ ___" will underline
+"Foo" and "Baz" but not "Bar".
</para>
@label: The #GtkLabel you want to set the pattern to.
<!-- ##### FUNCTION gtk_label_set_justify ##### -->
-<para>\r
-Set where the text within the #GtkLabel will align to. This can be one of\r
-four values: GTK_JUSTIFY_LEFT, GTK_JUSTIFY_RIGHT, GTK_JUSTIFY_CENTER,\r
-and GTK_JUSTIFY_FILL. GTK_JUSTIFY_CENTER is the default value when the\r
-widget is first created with gtk_label_new().\r
+<para>
+
</para>
-@label: The #GtkLabel widget you want to set justification for.
-@jtype: The #GtkJustification type as described above.
+@label:
+@jtype:
<!-- ##### FUNCTION gtk_label_get ##### -->
-<para>\r
-Gets the current string of text within the #GtkLabel and writes it to\r
-the given str argument. It does not make a copy of this string so you\r
-must not write to it.\r
+<para>
+Gets the current string of text within the #GtkLabel and writes it to
+the given @str argument. It does not make a copy of this string so you
+must not write to it.
</para>
@label: The #GtkLabel widget you want to get the text from.
<!-- ##### FUNCTION gtk_label_parse_uline ##### -->
-<para>\r
-Parses the given string for underscores and converts the next\r
-character to an underlined character. The last character that\r
-was underlined will have its lower-cased accelerator keyval returned (i.e.\r
-"_File" would return the keyval for "f". This is\r
-probably only used within the Gtk+ library itself for menu items and such.\r
+<para>
+Parses the given string for underscores and converts the next
+character to an underlined character. The last character that
+was underlined will have its lower-cased accelerator keyval returned (i.e.
+"_File" would return the keyval for "f". This is
+probably only used within the Gtk+ library itself for menu items and such.
</para>
@label: The #GtkLabel you want to affect.
<!-- ##### FUNCTION gtk_label_set_line_wrap ##### -->
-<para>\r
-Toggles line wrapping within the #GtkLabel widget. TRUE makes it break\r
-lines if text exceeds the widget's size. FALSE lets the text get cut off\r
-by the edge of the widget if it exceeds the widget size.\r
+<para>
+
</para>
-@label: The #GtkLabel you want to set line wrapping for.
-@wrap: TRUE turns it on; FALSE turns it off.
+@label:
+@wrap:
<!-- ##### MACRO gtk_label_set ##### -->
-<para>\r
-Aliases gtk_label_set_text. Probably used for backward compatibility with\r
-Gtk+ 1.0.x.\r
+<para>
+Aliases gtk_label_set_text(). Probably used for backward compatibility with
+Gtk+ 1.0.x.
</para>
@label:
@str:
-<!-- # Unused Parameters # -->
-@string:
<!-- ##### FUNCTION gtk_label_get_attributes ##### -->
@arg1:
<!-- ##### ARG GtkLabel:label ##### -->
-<para>\r
-The actual label text. Do not write to this pointer, it is not copied.\r
+<para>
+The actual label text. Do not write to this pointer, it is not copied.
</para>
<!-- ##### ARG GtkLabel:attributes ##### -->
</para>
<!-- ##### ARG GtkLabel:justify ##### -->
-<para>\r
-The #GtkJustification setting. See gtk_label_set_justify() for more info.\r
+<para>
+The #GtkJustification setting. See gtk_label_set_justify() for more info.
</para>
<!-- ##### ARG GtkLabel:pattern ##### -->
-<para>\r
-The pattern of underlines under the existing text. Do not change the\r
-pointer, it isn't copied.\r
+<para>
+The pattern of underlines under the existing text. Do not change the
+pointer, it isn't copied.
</para>
<!-- ##### ARG GtkLabel:wrap ##### -->
GtkText
<!-- ##### SECTION Short_Description ##### -->
-deprecated text widget, use #GtkTextView instead
+Deprecated text widget, use #GtkTextView instead.
<!-- ##### SECTION Long_Description ##### -->
-<para>\r
+<para>
<warning>
<para>
#GtkText is deprecated and unsupported. It is known to be
prior to including the GTK+ header files. Use #GtkTextView instead.
</para>
</warning>
-A #GtkText widget allows one to display any given text and manipulate it\r
-by deleting from one point to another, selecting a region, and various\r
-other functions as outlined below. It is inherited from #GtkEditable.\r
+A #GtkText widget allows one to display any given text and manipulate it
+by deleting from one point to another, selecting a region, and various
+other functions as outlined below. It is inherited from #GtkEditable.
</para>
<!-- ##### SECTION See_Also ##### -->
-<para>\r
-\r
+<para>
+
</para>
<!-- ##### STRUCT GtkText ##### -->
-<para>\r
-Most of the #GtkText-struct struct members should not be accessed directly.\r
-Listed below are a few exceptions and how to use them.\r
-\r
-<informaltable pgwide=1 frame="none" role="struct">\r
-<tgroup cols="2"><colspec colwidth="2*"><colspec colwidth="8*">\r
-<tbody>\r
-\r
-<row>\r
-<entry>GtkAdjustment *hadj;</entry>\r
-<entry>Allows you to see the state of an attached horizontal #GtkScrollbar.\r
-See #GtkAdjustment for more info. This allows easy access to the adjustments\r
-of the #GtkText struct without having to keep track of ones that you initialize\r
-at widget creation.</entry>\r
-</row>\r
-\r
-<row>\r
-<entry>GtkAdjustment *vadj;</entry>\r
-<entry>Same as hadj except it involves the vertical #GtkScrollbar.</entry>\r
-</row>\r
-\r
-</tbody></tgroup></informaltable>\r
-\r
+<para>
+Most of the #GtkText-struct struct members should not be accessed directly.
+Listed below are a few exceptions and how to use them.
</para>
+@hadj: Allows you to see the state of an attached horizontal #GtkScrollbar.
+ See #GtkAdjustment for more info. This allows easy access to the adjustments
+ of the #GtkText struct without having to keep track of ones that you
+ initialize at widget creation.
+@vadj: Same as @hadj except it involves the vertical #GtkScrollbar.
+
<!-- ##### STRUCT GtkTextFont ##### -->
-<para>\r
-Internal #GtkText data type.\r
-<!-- Pretty sure.. declared in gtktext.c -->\r
+<para>
+Internal #GtkText data type.
+<!-- Pretty sure.. declared in gtktext.c -->
</para>
<!-- ##### STRUCT GtkPropertyMark ##### -->
-<para>\r
-Internal #GtkText data type. Should not be access directly.\r
-<!-- FIXME: unsure about this -->\r
+<para>
+Internal #GtkText data type. Should not be accessed directly.
+<!-- FIXME: unsure about this -->
</para>
@property:
@index:
<!-- ##### FUNCTION gtk_text_new ##### -->
-<para>\r
-Creates a new #GtkText widget, initialized with the given pointers to\r
-#GtkAdjustments. These pointers can be used to track the viewing position\r
-of the #GtkText widget. Passing NULL to either or both of them will make\r
-the #GtkText create it's own. You can set these later with the function\r
-<function>gtk_text_set_adjustment()</function>\r
+<para>
+Creates a new #GtkText widget, initialized with the given pointers to
+#GtkAdjustments. These pointers can be used to track the viewing position
+of the #GtkText widget. Passing %NULL to either or both of them will make
+the #GtkText create it's own. You can set these later with the function
+gtk_text_set_adjustment().
</para>
@hadj: horizontal adjustment.
<!-- ##### FUNCTION gtk_text_set_editable ##### -->
-<para>\r
-Set whether the #GtkText widget can be edited by the user or not. This\r
-still allows you the programmer to make changes with the various #GtkText\r
-functions.\r
+<para>
+Sets whether the #GtkText widget can be edited by the user or not. This
+still allows you the programmer to make changes with the various #GtkText
+functions.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_set_word_wrap ##### -->
-<para>\r
-Sets whether the #GtkText widget wraps words down to the next line if it\r
-can't be completed on the current line.\r
+<para>
+Sets whether the #GtkText widget wraps words down to the next line if it
+can't be completed on the current line.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_set_line_wrap ##### -->
-<para>\r
-Controls how #GtkText handles long lines of continuous text. If line wrap\r
-is on, the line is broken when it reaches the extent of the #GtkText widget\r
-viewing area and the rest is displayed on the next line. If it is not set,\r
-the line continues regardless size of current viewing area. Similar to word\r
-wrap but it disregards word boundaries.\r
+<para>
+Controls how #GtkText handles long lines of continuous text. If line wrap
+is on, the line is broken when it reaches the extent of the #GtkText widget
+viewing area and the rest is displayed on the next line. If it is not set,
+the line continues regardless size of current viewing area. Similar to word
+wrap but it disregards word boundaries.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_set_adjustments ##### -->
-<para>\r
-Allows you to set #GtkAdjustment pointers which in turn allows you to\r
-keep track of the viewing position of the #GtkText widget.\r
+<para>
+Allows you to set #GtkAdjustment pointers which in turn allows you to
+keep track of the viewing position of the #GtkText widget.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_set_point ##### -->
-<para>\r
-Sets the cursor at the given point. In this case a point constitutes\r
-the number of characters from the extreme upper left corner of the #GtkText\r
-widget.\r
+<para>
+Sets the cursor at the given point. In this case a point constitutes
+the number of characters from the extreme upper left corner of the #GtkText
+widget.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_get_point ##### -->
-<para>\r
-Gets the current position of the cursor as the number of characters from\r
-the upper left corner of the #GtkText widget.\r
+<para>
+Gets the current position of the cursor as the number of characters from
+the upper left corner of the #GtkText widget.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_get_length ##### -->
-<para>\r
-Returns the length of the all the text contained within the #GtkText widget;\r
-disregards current point position.\r
+<para>
+Returns the length of the all the text contained within the #GtkText widget;
+disregards current point position.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_freeze ##### -->
-<para>\r
-Freezes the #GtkText widget which disallows redrawing of the widget until\r
-it is thawed. This is useful if a large number of changes are going to\r
-made to the text within the widget, reducing the amount of flicker seen\r
-by the user.\r
+<para>
+Freezes the #GtkText widget which disallows redrawing of the widget until
+it is thawed. This is useful if a large number of changes are going to
+made to the text within the widget, reducing the amount of flicker seen
+by the user.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_thaw ##### -->
-<para>\r
-Allows the #GtkText widget to be redrawn again by GTK.\r
+<para>
+Allows the #GtkText widget to be redrawn again by GTK.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_insert ##### -->
-<para>\r
-Inserts given text into the #GtkText widget with the given properties as\r
-outlined below.\r
+<para>
+Inserts given text into the #GtkText widget with the given properties as
+outlined below.
</para>
@text: the #GtkText widget
@fore: the foreground color to insert with
@back: the background color to insert with
@chars: the actual text to be inserted
-@length: the length of the text to be inserted, passing -1 makes it insert\r
+@length: the length of the text to be inserted, passing -1 makes it insert
all the text.
<!-- ##### FUNCTION gtk_text_backward_delete ##### -->
-<para>\r
-Deletes from the current point position backward the given number of\r
-characters.\r
+<para>
+Deletes from the current point position backward the given number of
+characters.
</para>
@text: the #GtkText widget
<!-- ##### FUNCTION gtk_text_forward_delete ##### -->
-<para>\r
-Deletes from the current point position forward the given number of\r
-characters.\r
+<para>
+Deletes from the current point position forward the given number of
+characters.
</para>
@text: the #GtkText widget
<!-- ##### MACRO GTK_TEXT_INDEX ##### -->
-<para>\r
-Returns the character at the given index within the #GtkText widget.\r
+<para>
+Returns the character at the given index within the #GtkText widget.
</para>
@t: the #GtkText widget
@arg2:
<!-- ##### ARG GtkText:hadjustment ##### -->
-<para>\r
-Used by the #GtkText widget to keep track of the size of it's horizontal\r
-text.\r
+<para>
+Used by the #GtkText widget to keep track of the size of it's horizontal
+text.
</para>
<!-- ##### ARG GtkText:vadjustment ##### -->
-<para>\r
-Used by the #GtkText widget to keep track of the size of it's vertical\r
-text.\r
+<para>
+Used by the #GtkText widget to keep track of the size of it's vertical
+text.
</para>
<!-- ##### ARG GtkText:line-wrap ##### -->
-<para>\r
-Boolean value indicating whether line wrap is enabled or not.\r
+<para>
+Boolean value indicating whether line wrap is enabled or not.
</para>
<!-- ##### ARG GtkText:word-wrap ##### -->
-<para>\r
-Boolean value indicated whether word wrap is enabled or not.\r
+<para>
+Boolean value indicated whether word wrap is enabled or not.
</para>
GtkTree
<!-- ##### SECTION Short_Description ##### -->
-Deprecated tree widget (use #GtkTreeView instead).
+Deprecated tree widget, use #GtkTreeView instead.
<!-- ##### SECTION Long_Description ##### -->
<para>
<para>
#GtkTree is deprecated and unsupported. It is known to be
buggy. To use it, you must define the symbol %GTK_ENABLE_BROKEN
-prior to including the GTK+ header files. Use #GtkTreeView intead.
+prior to including the GTK+ header files. Use #GtkTreeView instead.
</para>
</warning>
The #GtkTree widget is a container that shows users a list of items, in a tree format complete with branches and leafnodes. Branches can be expanded to show their child items, or collapsed to hide them.
@tree: A pointer to a #GtkTree.
@tree_item: A pointer to the #GtkWidget that is to be added to the tree.
-@position: A #gint that indicates the position in the tree, that the tree_item is to be added at.
+@position: A #gint that indicates the position in the tree, that the @tree_item is to be added at.
<!-- ##### FUNCTION gtk_tree_remove_items ##### -->
</para>
@tree: A pointer to a #GtkTree.
-@start: A gint.
-@end: A gint.
+@start: A #gint.
+@end: A #gint.
<!-- ##### FUNCTION gtk_tree_select_item ##### -->
</para>
@tree: A pointer to a #GtkTree.
-@item: A gint.
+@item: A #gint.
<!-- ##### FUNCTION gtk_tree_unselect_item ##### -->
</para>
@tree: A pointer to a #GtkTree.
-@item: A gint.
+@item: A #gint.
<!-- ##### FUNCTION gtk_tree_select_child ##### -->
@tree: A pointer to a #GtkTree.
@child: A pointer to a #GtkWidget.
-@Returns: A gint.
+@Returns: A #gint.
<!-- ##### FUNCTION gtk_tree_set_selection_mode ##### -->
</para>
@tree: A pointer to a #GtkTree.
-@flag: A guint, indicating %TRUE, or %FALSE.
+@flag: A #guint, indicating %TRUE, or %FALSE.
<!-- ##### FUNCTION gtk_tree_remove_item ##### -->
GtkTreeItem
<!-- ##### SECTION Short_Description ##### -->
-
+The widget used for items in a #GtkTree.
<!-- ##### SECTION Long_Description ##### -->
<para>
<para>
#GtkTree is deprecated and unsupported. It is known to be
buggy. To use it, you must define the symbol %GTK_ENABLE_BROKEN
-prior to including the GTK+ header files. Use #GtkTreeView intead.
+prior to including the GTK+ header files. Use #GtkTreeView instead.
</para>
</warning>
</para>
<refname>Tree and List Widget Overview</refname>
<refpurpose>Overview of <link
linkend="GtkTreeModel">GtkTreeModel</link>, <link
- linkend="GtkTreeView">GtkTreeView</link>, and other assocoiated widgets</refpurpose>
+ linkend="GtkTreeView">GtkTreeView</link>, and other associated widgets</refpurpose>
</refnamediv>
<refsect1>
+2001-12-05 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk-pixbuf.h (gdk_pixbuf_ref, gdk_pixbuf_unref,
+ gdk_pixbuf_animation_ref, gdk_pixbuf_animation_unref):
+ Deprecate. (#66208)
+
Tue Dec 4 11:45:45 2001 Owen Taylor <otaylor@redhat.com>
* io-xpm.c (pixbuf_create_from_xpm): Fill in color
/* Reference counting */
+#ifndef GDK_PIXBUF_DISABLE_DEPRECATED
GdkPixbuf *gdk_pixbuf_ref (GdkPixbuf *pixbuf);
void gdk_pixbuf_unref (GdkPixbuf *pixbuf);
+#endif
/* GdkPixbuf accessors */
GdkPixbufAnimation *gdk_pixbuf_animation_new_from_file (const char *filename,
GError **error);
+#ifndef GDK_PIXBUF_DISABLE_DEPRECATED
GdkPixbufAnimation *gdk_pixbuf_animation_ref (GdkPixbufAnimation *animation);
void gdk_pixbuf_animation_unref (GdkPixbufAnimation *animation);
+#endif
int gdk_pixbuf_animation_get_width (GdkPixbufAnimation *animation);
int gdk_pixbuf_animation_get_height (GdkPixbufAnimation *animation);
gint width,
gint height);
+#ifndef GDK_DISABLE_DEPRECATED
GdkImage* gdk_image_get (GdkDrawable *drawable,
gint x,
gint y,
gint width,
gint height);
-#ifndef GDK_DISABLE_DEPRECATED
GdkImage * gdk_image_ref (GdkImage *image);
void gdk_image_unref (GdkImage *image);
#endif
gint gdk_window_get_origin (GdkWindow *window,
gint *x,
gint *y);
+
+#ifndef GDK_DISABLE_DEPRECATED
gboolean gdk_window_get_deskrelative_origin (GdkWindow *window,
gint *x,
gint *y);
+#endif
+
void gdk_window_get_root_origin (GdkWindow *window,
gint *x,
gint *y);
* is %GTK_BUTTONBOX_START, %GTK_BUTTONBOX_SPREAD or
* %GTK_BUTTONBOX_EDGE, and before the the other children if the style
* is %GTK_BUTTONBOX_END. For horizontal button boxes, the definition
- * of before/after depends on direction of the widget. (See
- * gtk_widget_set_direction()) If the style is %GTK_BUTTONBOX_START,
- * or %GTK_BUTTONBOX_START, then the secondary children are aligned at
+ * of before/after depends on direction of the widget (see
+ * gtk_widget_set_direction()). If the style is %GTK_BUTTONBOX_START
+ * or %GTK_BUTTONBOX_END, then the secondary children are aligned at
* the other end of the button box from the main children. For the
* other styles, they appear immediately next to the main children.
**/
GtkUpdateType policy)
{
g_return_if_fail (GTK_IS_COLOR_SELECTION (colorsel));
- /* */
- g_warning (G_STRLOC ": This function is deprecated.");
}
/**
* Retrieves the horizontal focus adjustment for the container. See
* gtk_container_set_focus_hadjustment ().
*
- * Return value: the horizontal focus adjustment, or %NULL if none
+ * Return value: the horizontal focus adjustment, or %NULL if
* none has been set.
**/
GtkAdjustment *
* @event: a expose event sent to container
*
* When a container receives an expose event, it must send synthetic
- * expose events to all children that don't have their own GdkWindows.
+ * expose events to all children that don't have their own #GdkWindows.
* This function provides a convenient way of doing this. A container,
- * when it receives an expose event, gtk_container_propagate_expose()
+ * when it receives an expose event, calls gtk_container_propagate_expose()
* once for each child, passing in the event the container received.
*
* gtk_container_propagate_expose() takes care of deciding whether
* the event's area with the child area, and sending the event.
*
* In most cases, a container can simply either simply inherit the
- * ::expose implementation from GtkContainer, or, do some drawing
+ * ::expose implementation from #GtkContainer, or, do some drawing
* and then chain to the ::expose implementation from GtkContainer.
**/
void
* gtk_label_new:
* @str: The text of the label
*
- * Creates a new #GtkLabel, containing the text in @str.
+ * Creates a new label with the given text inside it. You can
+ * pass %NULL to get an empty label widget.
*
* Return value: the new #GtkLabel
**/
/**
* gtk_label_set_text:
* @label: a #GtkLabel
- * @str: a string
+ * @str: The text you want to set.
*
- * Sets the text of the label to @str.
+ * Sets the text within the #GtkLabel widget. It overwrites any text that
+ * was there before.
*
* This will also clear any previously set mnemonic accelerators.
**/
* @jtype: a #GtkJustification
*
* Sets the alignment of the lines in the text of the label relative to
- * each other.
+ * each other. %GTK_JUSTIFY_CENTER is the default value when the
+ * widget is first created with gtk_label_new().
**/
void
gtk_label_set_justify (GtkLabel *label,
* @label: a #GtkLabel
* @wrap: the setting
*
- * If true, the lines will be wrapped if the text becomes too wide.
- */
+ * Toggles line wrapping within the #GtkLabel widget. %TRUE makes it break
+ * lines if text exceeds the widget's size. %FALSE lets the text get cut off
+ * by the edge of the widget if it exceeds the widget size.
+ **/
void
gtk_label_set_line_wrap (GtkLabel *label,
gboolean wrap)
* @Varargs: all #GType types for the columns, from first to last
*
* Creates a new list store as with @n_columns columns each of the types passed
- * in. As an example, gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
- * GDK_TYPE_PIXBUF); will create a new GtkListStore with three columns, of type
- * int, string and GDkPixbuf respectively.
+ * in. As an example, <literal>gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
+ * GDK_TYPE_PIXBUF);</literal> will create a new #GtkListStore with three columns, of type
+ * int, string and #GdkPixbuf respectively.
*
* Return value: a new #GtkListStore
**/
* @n_columns: number of columns in the list store
* @types: an array of #GType types for the columns, from first to last
*
- * Non vararg creation function. Used primarily by language bindings.
+ * Non-vararg creation function. Used primarily by language bindings.
*
* Return value: a new #GtkListStore
**/
* gtk_list_store_set_column_types:
* @list_store: A #GtkListStore
* @n_columns: Number of columns for the list store
- * @types: An array length n of @GTypes
+ * @types: An array length n of #GTypes
*
- * This function is meant primarily for GObjects that inherit from GtkListStore,
- * and should only be used when constructing a new @GtkListStore. It will not
- * function after a row has been added, or a method on the @GtkTreeModel
+ * This function is meant primarily for #GObjects that inherit from #GtkListStore,
+ * and should only be used when constructing a new #GtkListStore. It will not
+ * function after a row has been added, or a method on the #GtkTreeModel
* interface is called.
**/
void
* The variable argument list should contain integer column numbers,
* each column number followed by the value to be set.
* The list is terminated by a -1. For example, to set column 0 with type
- * %G_TYPE_STRING to "Foo", you would write gtk_list_store_set (store, iter,
- * 0, "Foo", -1).
+ * %G_TYPE_STRING to "Foo", you would write <literal>gtk_list_store_set (store, iter,
+ * 0, "Foo", -1)</literal>.
**/
void
gtk_list_store_set (GtkListStore *list_store,
* @list_store: A #GtkListStore
* @iter: An unset #GtkTreeIter to set to the prepend row
*
- * Prepend a new row to @list_store. @iter will be changed to point to this new
+ * Prepends a new row to @list_store. @iter will be changed to point to this new
* row. The row will be empty after this function is called. To fill in
* values, you need to call gtk_list_store_set() or gtk_list_store_set_value().
*
gtk_tree_path_free (path);
}
+/**
+ * gtk_list_store_clear:
+ * @list_store: a #GtkListStore.
+ *
+ * Removes all rows from the list store.
+ *
+ **/
void
gtk_list_store_clear (GtkListStore *list_store)
{
return style;
}
-/*************************************************************
+/**
* gtk_style_attach:
- * Attach a style to a window; this process allocates the
- * colors and creates the GC's for the style - it specializes
- * it to a particular visual and colormap. The process
- * may involve the creation of a new style if the style
- * has already been attached to a window with a different
- * style and colormap.
- * arguments:
- * style:
- * window:
- * results:
- * Either the style parameter, or a newly created style.
- * If the style is newly created, the style parameter
- * will be dereferenced, and the new style will have
- * a reference count belonging to the caller.
+ * @style: a #GtkStyle.
+ * @window: a #GtkWindow.
+ * @returns: Either @style, or a newly-created #GtkStyle.
+ * If the style is newly created, the style parameter
+ * will be dereferenced, and the new style will have
+ * a reference count belonging to the caller.
*
+ * Attaches a style to a window; this process allocates the
+ * colors and creates the GC's for the style - it specializes
+ * it to a particular visual and colormap. The process may
+ * involve the creation of a new style if the style has already
+ * been attached to a window with a different style and colormap.
+ **/
+ /*
* FIXME: The sequence -
* create a style => s1
* attach s1 to v1, c1 => s1
* passes through the linked list when attaching (one to check for
* matching styles, one to look for empty unattached styles - but
* it will almost never be longer than 2 elements.
- *************************************************************/
-
+ */
GtkStyle*
gtk_style_attach (GtkStyle *style,
GdkWindow *window)
projects / gtk4.git / commitdiff